home *** CD-ROM | disk | FTP | other *** search
/ Aminet 45 / Aminet 45 (2001)(GTI - Schatztruhe)[!][Oct 2001].iso / Aminet / game / role / ldmud-3.2-bin.lha / mud / doc / efun / load_name < prev    next >
Text File  |  2001-08-06  |  2KB  |  46 lines
  1. SYNOPSIS
  2.         string load_name()
  3.         string load_name(object obj)
  4.         string load_name(string obj)
  5.  
  6. DESCRIPTION
  7.         Return the load name for the object <obj> which may be given
  8.         directly or by its name.
  9.         
  10.         If <obj> is a clone, return the load_name() of <obj>'s blueprint.
  11.         If <obj> is a blueprint, return the filename from which the
  12.         blueprint was compiled.
  13.  
  14.         If <obj> is given by name but not/no longer existing, the
  15.         function synthesizes the load name as it should be and returns
  16.         that. If the given name is illegal, the function returns 0.
  17.  
  18.         As a special case, if <ob> is 0, the function returns 0.
  19.  
  20.         For virtual objects this efun of course returns the virtual filename.
  21.         If <obj> is omitted, the name for the current object is returned.
  22.  
  23.         In contrast to the object_name(), the load name can not be changed
  24.         by with rename_object(). However, if an object uses replace_program()
  25.         the load name no longer reflects the actual behaviour of an object.
  26.  
  27.         The returned name starts with a '/', unless the driver is running
  28.         in COMPAT mode.
  29.  
  30. EXAMPLE
  31.         object o;
  32.         o = clone_object("/std/thing");
  33.         write(load_name(o));  --> writes "/std/thing" in !compat mode
  34.                                      and "std/thing"  in compat mode
  35.         write(load_name("/std/thing"));  --> same as above
  36.         write(load_name("/std/thing#4n5")); --> writes 0 
  37.  
  38. HISTORY
  39.         Introduced in LDMud 3.2.6.
  40.         Strings are accepted as arguments since 3.2.8.
  41.         0 is accepted as argument since 3.2.9.
  42.  
  43. SEE ALSO
  44.         clone_object(E), clonep(E), object_name(E), load_object(E),
  45.         replace_program(E), program_name(E), present_clone(E)
  46.